docs: add release-artifact reference and doctor/config sections#12
Merged
Merged
Conversation
Add docs/release-artifact.md covering the subsystems that had no dedicated documentation after the v1.1 rollout: - release.yaml full field reference with all optional spec sub-models (routing, safety, tools, prompts, tags) - bundle directory layout and which files are excluded from the checksum - bundle checksum algorithm: file collection, sort order, text normalization (CRLF→LF), and hash construction - flightdeck.yaml (WorkspaceConfig) field reference with defaults and relationship between diff.min_* workspace defaults and policy overrides - pricing table YAML format with all rate fields and the cached_input_usd_per_1k_tokens optional field - flightdeck pricing import / --replace / --reason semantics and the pricing_import_audit table - pricing accuracy note: cross-release pricing_reference differences and how pricing_or_model_changed is surfaced in diffs Update docs/operations-and-policy.md: - Add opening cross-reference to release-artifact.md - Add flightdeck doctor section explaining the three checks (schema_migrations, promoted_pointer, audit_seq), output format, exit behavior, and audit_seq gap-detection semantics Update README.md Documentation section to link release-artifact.md. Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add
docs/release-artifact.md, a new reference document covering the on-disk formats that had no dedicated documentation after the v1.1 rollout. Updatedocs/operations-and-policy.mdwith aflightdeck doctorsection and a cross-reference to the new doc. UpdateREADME.mdto link the new page.Why
After the v1.1 docs push (HTTP API, SDK, operations/policy), three important subsystems still had no reference page:
release.yamlschema (all spec sub-models: routing, safety, tools, prompts, tags) had no field-level docsflightdeck.yaml) was referenced everywhere but never documented--replace/--reasonsemantics, andpricing_import_auditwere undocumentedflightdeck doctorand its three checks had no operational runbook entryChanges
docs/release-artifact.md(new, 216 lines):release.yamlfull field reference with all optionalspecsub-modelsflightdeck.yaml(WorkspaceConfig) field reference with defaults and relationship to policymin_*overridescached_input_usd_per_1k_tokensoptional fieldflightdeck pricing import/--replace/--reasonsemantics and thepricing_import_audittablepricing_referencedifferences andpricing_or_model_changedflagdocs/operations-and-policy.md(updated):release-artifact.mdflightdeck doctorsection covering the three checks (schema_migrations,promoted_pointer,audit_seq), example output, exit behavior, and audit_seq gap-detection semanticsREADME.md(updated):docs/release-artifact.mdin the Documentation sectionValidation
uv sync --frozen --extra devuv run python -m ruff check src testsuv run python -m pytestuv run python scripts/generate_schemas.pythengit diff --exit-code schemas/(if models/schemas touched)cd web && npm ci && npm run build && cd .. && git diff --exit-code src/flightdeck/server/static/(ifweb/src/or deps changed)uv run flightdeck-quickstart-verifyuv run flightdeck --helpThis PR is docs-only; no Python source, schemas, or web assets were modified.
Schema / Storage Impact
Risk
Documentation only. No code changes. All content was verified against the actual source (
src/flightdeck/bundle.py,models.py,config.py,doctor.py,storage.py,cli/main.py).Notes
Covers the knowledge gaps identified by comparing the v1.1 codebase to the docs that shipped with it.